home *** CD-ROM | disk | FTP | other *** search
/ Dr. Windows 3 / dr win3.zip / dr win3 / PROGRAMR / HLPDK80.ZIP / HELPDEMO.HDF < prev    next >
Text File  |  1993-08-01  |  5KB  |  114 lines
  1. ;******************************************************************************
  2. ;                                  HELPDEMO                                   *
  3. ;******************************************************************************
  4.  
  5.  these lines are remark lines, only lines that appear between the help
  6.  definitions directives are processed by the help compiler, or lines that
  7.  start with a period and a reserved command such as .include or .linkcolor
  8.  
  9.  The next section defines a topic called overview. You must have a
  10.  topic like that in your database, it is the entry point of the 
  11.  help database, when the help engine displays the first page of
  12.  the database.
  13.  
  14. ;******************************************************************************
  15. ;                                  overview                                   *
  16. ;******************************************************************************
  17. .entry overview
  18.  
  19. This is the first line of the overview topic in the help demo database.
  20. The previous line did not have any ~link~link~, while this one does.
  21.  
  22. Press the Enter key to view the link topic help page.
  23.  
  24. .end-entry
  25.  
  26.  As can be seen, the only link available from the overview page is a topic
  27.  called link. In the next section we will define the link topic, and
  28.  include 2 links in it. One to the previous link (overview), and an
  29.  additional one - somewhere else.
  30.  
  31. ;******************************************************************************
  32. ;                                    link                                     *
  33. ; notice that this topic's title will be different then the topic name        *
  34. ; because of the use of the .TITLE keyword.                                   *
  35. ; notice also that the topic is defined by .topic and .end-topic which are    *
  36. ; the same as the .entry .end-entry keywords                                  *
  37. ;******************************************************************************
  38. .topic link
  39. .title This is the 2nd screen
  40.  
  41. .paragraph
  42. Welcome to the link help page, since this is a demo help database, we 
  43. know that you arrived to this page from the ~overview~overview~ page, 
  44. by pressing the link hot-link. In this page we will demonstrate the 
  45. ability to include 2 different names (or more) that will take us to the 
  46. same link.
  47. .end-paragraph
  48.  
  49. Example :
  50.  
  51. Related Topics : ~Topic~Topic~
  52.                  ~General~overview~
  53. .end-topic
  54.  
  55.  In the above section we defined 3 links, that are linked to 2 topics, we
  56.  showed that we can reach the same topic from more then one spot in the 
  57.  same topic, using different names.
  58.  
  59.  We will now define the third and final page in the helpdemo database, this
  60.  topic is called topic. Notice that if we did not include this one, the
  61.  helpC help compiler would have told us that there is a link defined,
  62.  that is not defined as a topic.
  63.  
  64. ;******************************************************************************
  65. ;                                    Topic                                    *
  66. ;******************************************************************************
  67. .entry Topic
  68.  
  69. .paragraph
  70. Well.. it seems as if you succeeded to reach this point by yourself, 
  71. this is the 3rd page of the HELPDEMO help database. From this 
  72. help page you can go to the ~previous~link~ help page, or to the 
  73. ~entry~overview~ help page. 
  74. .end-paragraph
  75.  
  76. Have fun using the help compiler and help engine ..
  77.  
  78. Notice - this line demostrates the use of a ~~ in a text page.
  79. (Please refer to the HELPDEMO.HDF file an example .. )
  80.  
  81. .paragraph
  82. There are more pages you can get to from here - One of these links is defined 
  83. in a ~.INCLUDE~include~ file. Please refer to the helpC documentation for 
  84. HDF syntax.
  85.  
  86. Notice how you get a ~Popup~popupLink~ here!.
  87.  
  88. .end-paragraph
  89.  
  90. .end-entry
  91.  
  92. ;******************************************************************************
  93. ;                                  .include                                   *
  94. ; here we add a new topic from a 2nd file that is included 2nddemo.hdf        *
  95. ;******************************************************************************
  96. .include 2NDDEMO.HDF
  97.  
  98. ;******************************************************************************
  99. ;                                   .popup                                    *
  100. ; here we demonstrate the definition of a popup topic screen                  *
  101. ; we also demonstrate the conditional defines .ifdef/.else/.endif             *
  102. ;******************************************************************************
  103. .popup popupLink
  104. .title A POPUP Screen
  105.  
  106. This is a Popup screen, No links can be defined in this screen, you have to 
  107. .ifdef native
  108. press F3 to close this popup, F6 to cycle between windows.
  109. .else
  110. press enter to return to the calling help screen.
  111. .endif
  112.  
  113. .end-popup
  114.